REST

SCS provides a very basic RESTA REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer and was created by computer scientist Roy Fielding. APIAn application programming interface is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. for users to call remotely via their own applications. You can access this API via HTTP GET calls to the primary SCS web server with the /SVC route.

If you have a need or suggestion to improve this functionality for your usage please reach out. As this is a more advanced feature of SCS we have not built out to robust an interface as we are not as cognizant of the user-bases requirements so we're very willing to tailor it once we know what exactly you need.

By default all methods below are HTTP GETThe GET method requests that the target resource transfers a representation of its state. GET requests should only retrieve data and should have no other effect. , any deviation will be otherwise noted for the given endpoint.

GetCurrentDeviceConfiguration

[SCS HOST]/svc/GetCurrentDeviceConfiguration

Returns the current device configuration XML for the ship

GetDeviceConfiguration

[SCS HOST]/svc/GetDeviceConfiguration/{xmlReleaseID}

Returns a specific device configuration XML for the ship based upon the passed xmlReleaseID parameter

GetMessageDefinitionForDataField

[SCS HOST]/svc/GetMessageDefinitionForDataField/{xmlReleaseID}/{datafieldID}

Returns the configuration XML for a single Message Definition which contains a specific datafield.

xmlReleaseID parameter will specific which Device Configuration to search

datafieldID parameter will search the Device Configuration for the single specific Data Field who's parent Message Definition will be returned.

GetAcqLoggingStatus

[SCS HOST]/svc/GetAcqLoggingStatus

Returns JSON informing caller whether or not ACQ is currently logging or not.

This does NOT indicate if ACQ service itself is running or not. ACQ may be actively sending out data to clients even if it is not logging that data to disk!

JSON will have a success boolean, a state string and optionally an errorMsg string if an error is encountered.

IsRunningLatestVersionOfSCS

[SCS HOST]/svc/IsRunningLatestVersionOfSCS

Returns a JSON result informing caller if local ship installation of SCS matches what is currently available from shore.

JSON will have a single isUpToDate boolean.

GetEventData

[SCS HOST]/svc/GetEventData/{eventIdStr}/{format?}

Returns data collected by an SCS Event in the requested format.

The eventIdStr parameter can be obtained by the event itself. The conceptualized flow here is that the event calls your code via an Execute Web Hook action sequence (which provides your code with the eventID string used here) when appropriate (such as when the event ends so you can automatically and instantly download the event data).

eventIdStr parameter is the ID of the event run you wish to query for data